From 082096f91a71a28fec0a397cefe598f56ace6a1f Mon Sep 17 00:00:00 2001 From: Andrew Cooper Date: Tue, 26 Apr 2016 18:34:34 +0100 Subject: [PATCH] docs/feature: Tweaks to the feature document template During review of the migration feature doc, some changes were made which should have been reflected in the template. Signed-off-by: Andrew Cooper Release-acked-by: Wei Liu --- docs/features/template.pandoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/features/template.pandoc b/docs/features/template.pandoc index 7698291559..82881e3d21 100644 --- a/docs/features/template.pandoc +++ b/docs/features/template.pandoc @@ -29,22 +29,22 @@ Architecture(s): e.g. x86, arm A short description the feature, similar to an abstract for a paper/presentation. -# User information +# User details Information for a user attempting to use the feature. Should include how to enable the feature (is it enabled by default? If not, how to turn it on?), and how to interact with the feature (typically via `xl`). +# Technical details + +Information for a developer or power user. Should include where to look +in-tree for detailed documents and code. + # Limitations Information concerning incompatibilities with other features or hardware combinations. -# Technical information - -Information for a developer or power user. Should include where to look -in-tree for detailed documents and code. - # Testing Information concerning how to properly test changes affecting this feature. -- 2.30.2